home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.5 Complementary Applications 2004 February / SGI IRIX 6.5 Complementary Applications 2004 February.iso / dist / cde.idb / usr / dt / share / man / cat3 / MrmFetchWidget.z / MrmFetchWidget
Encoding:
Text File  |  2003-11-18  |  5.1 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeetttt((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeetttt((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       _M_r_m_F_e_t_c_h_W_i_d_g_e_t - Fetches and creates any indexed (UIL    named)
  10.       application widgets and its children
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.       #include <Mrm/MrmPublic.h>
  14.  
  15.       Cardinal MrmFetchWidget(hhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd,,,,    iiiinnnnddddeeeexxxx,,,, ppppaaaarrrreeeennnntttt____wwwwiiiiddddggggeeeetttt,,,, wwwwiiiiddddggggeeeetttt,,,, ccccllllaaaassssssss)
  16.            _M_r_m_H_i_e_r_a_r_c_h_yhhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd;
  17.            _S_t_r_i_n_g     iiiinnnnddddeeeexxxx;
  18.            _W_i_d_g_e_t     ppppaaaarrrreeeennnntttt____wwwwiiiiddddggggeeeetttt;
  19.            _W_i_d_g_e_t     *wwwwiiiiddddggggeeeetttt;
  20.            _M_r_m_T_y_p_e     *ccccllllaaaassssssss;
  21.  
  22.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  23.       The _M_r_m_F_e_t_c_h_W_i_d_g_e_t function fetches and creates an indexed
  24.       application widget and its children.    The indexed
  25.       application widget is    any widget that    is named in UIL.  In
  26.       fetch    operations, the    fetched    widget's subtree is also
  27.       fetched and created.    This widget must not appear as the
  28.       child    of a widget within its own subtree. _M_r_m_F_e_t_c_h_W_i_d_g_e_t
  29.       does not execute _X_t_M_a_n_a_g_e_C_h_i_l_d for the newly created widget.
  30.  
  31.       hhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd
  32.            Specifies the ID    of the _u_i_d hierarchy that contains the
  33.            interface definition.  The hhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd was returned in
  34.            a previous call to _M_r_m_O_p_e_n_H_i_e_r_a_r_c_h_y_P_e_r_D_i_s_p_l_a_y.
  35.  
  36.       iiiinnnnddddeeeexxxx
  37.            Specifies the UIL name of the widget to fetch.
  38.  
  39.       ppppaaaarrrreeeennnntttt____wwwwiiiiddddggggeeeetttt
  40.            Specifies the parent widget ID.
  41.  
  42.       wwwwiiiiddddggggeeeetttt
  43.            Returns the widget ID of    the created widget.
  44.  
  45.       ccccllllaaaassssssss
  46.            Returns the class code identifying MRM's    widget class.
  47.            The widget class    code for the main window widget, for
  48.            example,    is _M_R_M_w_c_M_a_i_n_W_i_n_d_o_w.  Literals identifying MRM
  49.            widget class codes are defined in _M_r_m._h.
  50.  
  51.       An application can fetch any named widget in the _u_i_d
  52.       hierarchy using _M_r_m_F_e_t_c_h_W_i_d_g_e_t.  _M_r_m_F_e_t_c_h_W_i_d_g_e_t can be
  53.       called at any    time to    fetch a    widget that was    not fetched at
  54.       application startup.    _M_r_m_F_e_t_c_h_W_i_d_g_e_t can be used to defer
  55.       fetching pop-up widgets until    they are first referenced
  56.       (presumably in a callback), and then used to fetch them
  57.       once.
  58.  
  59.       _M_r_m_F_e_t_c_h_W_i_d_g_e_t can also create multiple instances of a
  60.  
  61.  
  62.  
  63.      Page 1                        (printed 11/11/03)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeetttt((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeetttt((((3333XXXX))))
  71.  
  72.  
  73.  
  74.       widget (and its subtree).  In    this case, the _u_i_d definition
  75.       functions as a template; a widget definition can be fetched
  76.       any number of    times.    An application can use this to make
  77.       multiple instances of    a widget, for example, in a dialog box
  78.       box or menu.
  79.  
  80.       The index (UIL name) that identifies the widget must be
  81.       known    to the application.
  82.  
  83.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  84.       This function    returns    one of these status return constants:
  85.  
  86.       _M_r_m_S_U_C_C_E_S_S
  87.            The function executed successfully.
  88.  
  89.       _M_r_m_B_A_D__H_I_E_R_A_R_C_H_Y
  90.            The hierarchy ID    was invalid.
  91.  
  92.       _M_r_m_N_O_T__F_O_U_N_D
  93.            The widget was not found    in UID hierarchy.
  94.  
  95.       _M_r_m_F_A_I_L_U_R_E
  96.            The function failed.
  97.  
  98.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  99.       _M_r_m_O_p_e_n_H_i_e_r_a_r_c_h_y_P_e_r_D_i_s_p_l_a_y(_3_X), _M_r_m_F_e_t_c_h_W_i_d_g_e_t_O_v_e_r_r_i_d_e(_3_X).
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                        (printed 11/11/03)
  130.  
  131.  
  132.  
  133.